Cargar un nuevo documento de ayuda

 

1. Especificación técnica del documento de ayuda
2. Cargar un nuevo documento de ayuda
3. Agregar el documento a la ayuda

En este documento encontrara, no solo el proceso por medio del cual se logra agregar un nuevo ítem de ayuda, sino que adicionalmente, el lector logrará conocer la estructura que debe llevar un documento de ayuda, con el fin de proporcionar los medios necesarios para crear un nuevo documento de ayuda, que cumpla con los estándares de diseño del aplicativo.

1.Especificación técnica del documento de ayuda

Aunque puede parecer sin importancia, el tener un estándar de diseño de la ayuda, es de vital importancia para lograr mantener una identidad apropiada, para nuestros clientes. Con esta idea presente es imprescindible crear unas normas que se deben tener en cuenta en la creación de un nuevo documento de ayuda.

Antes de empezar a describir las normas específicas que debe contener el documento HTML, es importante recordar, que el documento debe cumplir a cabalidad con la estructura básica de un documento HTML, y que se podrán usar las etiquetas que considere apropiadas para dar una solución mas clara al lector del documento

Las especificaciones técnicas básicas que debe cumplir el nuevo documento HTML de ayuda son:

• El nombre del documento HTML que estamos creando, debe ser el nombre con el cual se desea que el tema de ayuda se vea en la página principal de la ayuda del programa. Por ejemplo: : Si deseo que en la página de ayuda, se vea en el árbol la palabra "Equipos" (que puede hacer referencia a la ayuda relacionada con los temas que involucran equipos de la empresa), el nombre del documento HTML que se está creando debe ser "Equipos.HTML"
  
  
• En el head del documento, siempre debe estar la siguiente etiqueta:
  
  <link href="../../css/ayuda.css" rel="stylesheet" type="text/css">
  
  Esta etiqueta asegura que nuestro documento se visualizara de la misma manera que todos los demás documentos que compongan la ayuda.
  
  
• El titulo principal del documento debe estar formado de las siguiente manera:
  
  <h1 class="Titulo"> Titulo principal </>
  
  
• El documento debe contener un menú con los contenidos de este. cada ítem del menú debe escribirse de la siguiente manera: <a href="#alias"> &IACUTE;tem del menú </a>
  
  En donde alias, será la palabra clave que enlazara el ítem del menú con su posición en el documento. E "&IACUTE;tem del documento" se refiere a el nombre de la sección.
  Teniendo en cuenta este punto, es necesario, especificar a qué parte del documento se desea que el menú lo dirija. Por ende el nombre de la sección deberá estar formada de la siguiente manera
  
  <h2 class="Subtitulo3"><a name="alias"> &IACUTE;tem del menú </a></h2>
  
  Donde name="alias" , forma el vinculo entre el menú y la posición de la sección del documento.
  
  

Nota:
Si se desea agregar una imagen al documento de ayuda, esta imagen debe ser priimero cargada en el servidor de la aplicación. La etiqueta de la imagen, estará formada de la siguiente manera:

<img src="../../images/ayuda/segdad_carg_carpform.jpg" width="194" height="187">

En donde "images/ayuda/segdad_carg_carpform.jpg" se refiere al directorio en el cual está la imagen.

2. Cargar un nuevo documento de ayuda

Para cargar un documento de ayuda al servidor se debe seguir la siguiente ruta:
menú principal -> avanzado -> ayuda -> clic en el botón "Cargar Ayuda" de la barra de herramientas.

Posteriormente, se abrirá una nueva página en el que se debe escoger el archivo y posteriormente se debe hacer clic en aceptar.

3. Agregar el documento a la ayuda

Para agregar un documento de ayuda a la página de ayuda del programa, se debe seguir la siguiente ruta:
menú principal -> avanzado -> ayuda -> clic en el botón nuevo de la barra lateral

en la pestaña info basica, en el campo de "ayuda" se debe escribir el nombre del archivo de ayuda que se desea agregar, en el campo "ayuda_codigo" , se especifica el "anchor" del nodo padre, al cual va a hacer referencia y en el campo de selección que dice "ayuda" , se selecciona el tema superior, en caso de que el tema a agregar, sea un subtema de un tema más amplio.